Rainbow Android SDK/com.ale.rainbowsdk/Voicemails

Voicemails

interface Voicemails

Types

Link copied to clipboard
object Companion
Link copied to clipboard
Link copied to clipboard
interface IVoicemailsListener

Interface defining callbacks for handling events related to Voicemails within the SDK.

Properties

Link copied to clipboard
abstract val busyGreeting: Greeting?

Get the greeting when user is busy. Only available for Cloud PBX.

Link copied to clipboard
abstract val busyUserGreeting: UserGreeting?

Get the user greeting when user is busy. Only available for Cloud PBX.

Link copied to clipboard
abstract val unavailableGreeting: Greeting?

Get the greeting when user is unavailable. Only available for Cloud PBX.

Link copied to clipboard
abstract val unavailableUserGreeting: UserGreeting?

Get the user greeting when user is unavailable. Only available for Cloud PBX.

Link copied to clipboard
abstract val voicemailCounter: Int

Get the current voicemail counter

Link copied to clipboard
abstract val voicemailList: ArrayItemList<Voicemail>

Get the visual voicemails list

Functions

Link copied to clipboard
abstract fun deleteAllVoicemail(listener: RainbowListener<Unit, Unit>? = null)

Delete all voicemails

Link copied to clipboard
abstract fun deleteCallGroupVoiceMail(callGroupId: String, voicemailId: String, listener: RainbowListener<Unit, Unit>? = null)

Deletes one call group voicemail with the given id

Link copied to clipboard
abstract fun deleteCallGroupVoicemails(callGroupId: String, voicemailIds: List<String>, listener: RainbowListener<List<String>, List<RainbowError<Unit>>>? = null)

Delete a list of call group voicemail

Link copied to clipboard
abstract fun deleteGreeting(busy: Boolean, listener: RainbowListener<Unit, Unit>?)

Delete the custom greeting to have the default one back.

Link copied to clipboard
abstract fun deleteVoicemail(voicemailId: String, listener: RainbowListener<Unit, Unit>?)

Delete one voicemail with the given id

Link copied to clipboard
abstract fun deleteVoicemails(voicemailIds: List<String>, listener: RainbowListener<List<String>, List<RainbowError<Unit>>>? = null)

Delete a list of voicemail

Link copied to clipboard
abstract fun fetchCallGroupsVoicemailCounter(listener: RainbowListener<Map<String, Int>, Unit>? = null)

Fetches the counter of voicemails for all groups.

Link copied to clipboard
abstract fun fetchCallGroupVoicemailList(callGroupId: String, listener: RainbowListener<List<Voicemail>, Unit>? = null)

Fetches a list of voicemails for a given call group.

Link copied to clipboard
abstract fun fetchVoicemail(voicemailId: String, voicemailDate: Date, callerNumber: String, listener: RainbowListener<Unit, Unit>? = null)

Let you load the file associated to a visual voicemail entry

Link copied to clipboard
abstract fun getCallGroupVoicemail(callGroupId: String): ArrayItemList<Voicemail>

Get the call group's voicemails list

Link copied to clipboard
abstract fun getCallGroupVoicemailCounter(callGroupId: String): Int

Get the call group's unread voicemail counter

Link copied to clipboard
abstract fun isVisualVoicemailAvailable(): Boolean

Let you know if visual voicemail is available for the current user

Link copied to clipboard
abstract fun markCallGroupVoicemailAsRead(callGroupId: String, voicemailId: String, listener: RainbowListener<Unit, Unit>? = null)

Marks a call group voicemail as read.

Link copied to clipboard
abstract fun markVoicemailAsRead(voicemailId: String)

Mark one voicemail with the given id as read. Only available for Cloud PBX.

Link copied to clipboard
abstract fun registerGreetingsChangeListener(listener: Voicemails.IGreetingsChangeListener)

Register a listener on the greetings

Link copied to clipboard
abstract fun registerVoicemailsListener(listener: Voicemails.IVoicemailsListener)

Registers an implementation of IVoicemailsListener to receive callbacks when the SDK notifies of a new event.

Link copied to clipboard
abstract fun restoreUserGreeting(userGreeting: UserGreeting, listener: RainbowListener<Unit, Unit>?)

Delete the custom user greeting to have the default one back.

Link copied to clipboard
abstract fun unregisterGreetingsChangeListener(listener: Voicemails.IGreetingsChangeListener)

Unregister the listener on the greetings

Link copied to clipboard
abstract fun unregisterVoicemailsListener(listener: Voicemails.IVoicemailsListener)

Unregisters a previously registered IVoicemailsListener, stopping callbacks for notifications.

Link copied to clipboard
abstract fun updateUserGreeting(userGreeting: UserGreeting, byteArray: ByteArray, mimeType: String, fileName: String, listener: RainbowListener<Unit, Unit>?)

Upload a custom user greeting.

Link copied to clipboard
abstract fun uploadGreeting(busy: Boolean, byteArray: ByteArray, mimeType: String, listener: RainbowListener<Unit, Unit>?)

Upload a custom greeting.